Rainbow Android SDK/com.ale.rainbowsdk/Bubbles

Bubbles

interface Bubbles

This module is used to manage bubbles.

A bubble is also called a room. This is exactly the same object.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
Link copied to clipboard
interface IRoomFoundListener

Properties

Link copied to clipboard
abstract val totalBubblesAvailable: Int

Get the total available bubbles corresponding to the last refresh request.

Link copied to clipboard
abstract val totalInvitedBubblesAvailable: Int

Get the total invited available bubbles.

Functions

Link copied to clipboard
abstract fun acceptInvitation(room: IRainbowRoom, listener: RainbowListener<RoomParticipant, Unit>? = null)

Accept an invitation to join a bubble.

Link copied to clipboard
abstract fun addParticipantsAndStartConference(currentCall: WebRTCCall, participants: ArrayList<IRainbowContact>, listener: RainbowListener<Unit, AddParticipantsAndStartConferenceError>)

Escalate a P2P call to a conference by adding participants

Link copied to clipboard
abstract fun addParticipantsToBubble(room: IRainbowRoom, contactsList: ArrayList<IRainbowContact>, listener: RainbowListener<Unit, AddRoomParticipantsError>? = null)

Add a list of participants to a bubble with invitations and as users.

abstract fun addParticipantsToBubble(room: IRainbowRoom, contactsList: ArrayList<IRainbowContact>, asModerators: Boolean, withInvitations: Boolean, listener: RainbowListener<Unit, AddRoomParticipantsError>? = null)

Add a list of participants to a bubble.

Link copied to clipboard
abstract fun addParticipantToBubble(room: IRainbowRoom, contact: IRainbowContact, listener: RainbowListener<Unit, AddRoomParticipantsError>? = null)

Add one participant to a bubble with invitation and as a user.

abstract fun addParticipantToBubble(room: IRainbowRoom, contact: IRainbowContact?, asModerator: Boolean, withInvitation: Boolean, listener: RainbowListener<Unit, AddRoomParticipantsError>? = null)

Add one participant to a bubble.

Link copied to clipboard
abstract fun archiveBubble(room: IRainbowRoom, listener: RainbowListener<IRainbowRoom, Unit>? = null)

Archive a bubble, Two possible cases:

Link copied to clipboard
abstract fun cancelInvitationGuestsToBubble(room: IRainbowRoom, guests: List<String>, listener: RainbowListener<Unit, Unit>? = null)

Cancel guests invitation to a bubble

Link copied to clipboard
abstract fun checkBubbleOwner(room: IRainbowRoom, contact: IRainbowContact, listener: RainbowListener<Unit, Map<String, ServicePlanErrorResponse>>? = null)

Check if the given contact can be used for changing the owner of the Bubble

Link copied to clipboard
abstract fun checkOpenInviteId(openInviteId: String, listener: RainbowListener<Unit, Unit>)

Check if the given openInviteId is still valid and can be used to join a bubble.

Link copied to clipboard
abstract fun createBubble(body: CreateRoomBody, listener: RainbowListener<IRainbowRoom, RoomRepository.CreateRoomError>? = null)

Create a bubble

Link copied to clipboard
abstract fun deleteAllCustomDataForBubble(room: IRainbowRoom, listener: RainbowListener<IRainbowRoom, Unit>? = null)

Delete all the customData of a bubble.

Link copied to clipboard
abstract fun deleteBubble(room: IRainbowRoom, listener: RainbowListener<Unit, Unit>? = null)

Delete a bubble

Link copied to clipboard
abstract fun deleteParticipantFromBubble(room: IRainbowRoom, contact: IRainbowContact, keepArchive: Boolean, listener: RainbowListener<Unit, Unit>? = null)

Delete one participant from a bubble.

Link copied to clipboard
abstract fun deleteRoomAvatar(roomId: String?, listener: RainbowListener<Unit, Unit>? = null)

Delete the photo of the specified room.

Link copied to clipboard
abstract fun demoteAllModeratorsToMembers(roomId: String, listener: RainbowListener<Unit, Unit>? = null)
Link copied to clipboard
abstract fun fetchBubbleTagSuggestions(listener: RainbowListener<List<RoomTag>, Unit>? = null)

Fetch all tags from all users Bubbles at server side

Link copied to clipboard
abstract fun findBubbleById(roomId: String?): Room?

Get a bubble from its id.

Link copied to clipboard
abstract fun findBubbleByJid(roomJid: String?): Room?

Get a bubble from its jid.

Link copied to clipboard
abstract fun findBubblesByName(name: String?): List<Room>

Get a bubble from its name.

Link copied to clipboard
abstract fun getAllBubbles(): ArrayItemList<Room>

Get all bubbles (including archived and pending).

Link copied to clipboard
abstract fun getAllInactiveBubbles(): ArrayList<Room>

Get user's inactive bubbles.

Link copied to clipboard
abstract fun getAllList(): ArrayList<Room>

Get all bubbles except pending, archived and inactive.

Link copied to clipboard
abstract fun getArchivedList(): ArrayList<Room>

Get archived bubbles.

Link copied to clipboard
abstract fun getDialInNumbers(listener: RainbowListener<RoomService.DialInNumbers, Unit>?)

Retrieve all available numbers for dial in feature.

Link copied to clipboard
abstract fun getMyList(): ArrayList<Room>

Get bubbles owned by the connected user.

Link copied to clipboard
abstract fun getPendingInactiveList(): ArrayList<Room>

Get pending inactive bubbles.

Link copied to clipboard
abstract fun getPendingList(): ArrayList<Room>

Get pending bubbles.

Link copied to clipboard
abstract fun getPublicLinkForBubble(room: IRainbowRoom, listener: RainbowListener<OpenInvite, Unit>? = null)

Get the public link for a given bubble.

Link copied to clipboard
abstract fun getRoomData(room: IRainbowRoom, listener: RainbowListener<IRainbowRoom?, Unit>? = null)

Let you refresh a bubble

Link copied to clipboard
abstract fun getSharingEmail(room: Room, language: String?, listener: RainbowListener<String, Unit>?)

Request server to generate email content for sharing a bubble.

Link copied to clipboard
abstract fun getUserQuotaConsumption(listener: RainbowListener<Consumption, Unit>? = null)

Get a Consumption object which allows to get the current bubble quota and consumption for the connected user

Link copied to clipboard
abstract fun hasInactiveBubbles(listener: RainbowListener<Boolean, Unit>? = null)

Allow to know if the connected user has some inactive bubbles

Link copied to clipboard
abstract fun inviteGuestsToBubble(room: IRainbowRoom, guests: List<String>, listener: RainbowListener<Map<String, String>, RoomRepository.InviteUsersRoomError>? = null)

Add guests to a bubble with invitation

Link copied to clipboard
abstract fun inviteUsersToBubble(room: IRainbowRoom, contactsList: ArrayList<IRainbowContact>, privilege: RoomParticipantPrivilege = RoomParticipantPrivilege.USER, listener: RainbowListener<Map<String, String>, RoomRepository.InviteUsersRoomError>? = null)

Invite a list of participants to a bubble.

Link copied to clipboard
abstract fun joinBubbleByPublicLink(openInviteId: String, listener: RainbowListener<IRainbowRoom, Unit>? = null)

Let the user join a shared Bubble with the id from its public link

Link copied to clipboard
abstract fun leaveBubble(room: IRainbowRoom, listener: RainbowListener<Unit, Unit>? = null)

Leave a room.

Link copied to clipboard
abstract fun loadAllBubblesParticipantIfNeeded(room: Room)

By default, only active or invited participants are loaded in a Bubble. To get others, this method will load them if not already done

Link copied to clipboard
abstract fun mergeCalls(calls: List<WebRTCCall>, listener: RainbowListener<Unit, AddParticipantsAndStartConferenceError>)

Merge several phone calls (P2P or PBX calls) into a conference.

Link copied to clipboard
abstract fun promoteAllMembersToModerators(roomId: String, listener: RainbowListener<Unit, Unit>? = null)
Link copied to clipboard
abstract fun refreshActiveBubbles(offset: Int, limit: Int, sortField: String = "lastActivityDate", sortOrder: Int = 1, listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Refresh all active bubbles from server.

Link copied to clipboard
abstract fun refreshAllInvitedBubbles(listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Refresh all invited bubbles from server. Limited to 500 bubbles.

Link copied to clipboard
abstract fun refreshArchivedBubbles(offset: Int, limit: Int, sortField: String = "lastActivityDate", sortOrder: Int = 1, listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Refresh all archived bubbles from server. Limited to 500 bubbles.

Link copied to clipboard
abstract fun refreshInactiveBubbles(offset: Int, limit: Int, sortField: String = "lastActivityDate", sortOrder: Int = 1, listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Refresh all inactive bubbles from server.

Link copied to clipboard
abstract fun refreshMyBubbles(offset: Int, limit: Int, sortField: String = "lastActivityDate", sortOrder: Int = 1, listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Refresh all user bubbles from server. Limited to 500 bubbles.

Link copied to clipboard
abstract fun registerPublicLinkSharingChangeListener(listener: Bubbles.IOpenInviteChangeListener)

Registers to all changes on public link (activation/deactivation) of your bubbles.

Link copied to clipboard
abstract fun rejectInvitation(room: IRainbowRoom, listener: RainbowListener<RoomParticipant, Unit>? = null)

Reject an invitation to join a bubble.

Link copied to clipboard
abstract fun resetBubbleByLink(bubbleId: String?, listener: RainbowListener<OpenInvite, Unit>? = null)

Reset the link for sharing a bubble.

Link copied to clipboard
abstract fun resetBubbleDialInCode(room: Room, listener: RainbowListener<String, Unit>?)

Reset the dialInCode for sharing a bubble by number.

Link copied to clipboard
abstract fun searchRooms(search: String, roomSearchCriteria: RoomSearchCriteria, listener: RainbowListener<List<IRainbowRoom>, Unit>? = null)

Let you search Bubbles with specific criteria.

Link copied to clipboard
abstract fun setParticipantPrivilegeToGuest(room: IRainbowRoom, contact: IRainbowContact, listener: RainbowListener<RoomParticipant, Unit>?)

Set the privilege of a participant to guest.

Link copied to clipboard
abstract fun setParticipantPrivilegeToModerator(room: IRainbowRoom, contact: IRainbowContact, listener: RainbowListener<RoomParticipant, Unit>?)

Set the privilege of a participant to moderator (promote).

Link copied to clipboard
abstract fun setParticipantPrivilegeToUser(room: IRainbowRoom, contact: IRainbowContact, listener: RainbowListener<RoomParticipant, Unit>?)

Set the privilege of a participant to user (demote).

Link copied to clipboard
abstract fun shareBubbleByLink(bubbleId: String?, listener: RainbowListener<OpenInvite, Unit>? = null)

Share the bubble by public link.

Link copied to clipboard
abstract fun shareBubbleByNumber(room: Room, listener: RainbowListener<String, Unit>?)

Share the bubble by number.

Link copied to clipboard
abstract fun stopSharingBubbleByLink(bubbleId: String?, listener: RainbowListener<OpenInvite, Unit>? = null)

Deactivate the sharing of the bubble by public link.

Link copied to clipboard
abstract fun stopSharingBubbleByNumber(room: Room, listener: RainbowListener<Unit, Unit>?)

Deactivate the sharing of the bubble by number.

abstract fun unregisterPublicLinkSharingChangeListener(listener: Bubbles.IOpenInviteChangeListener)

Unregisters to all changes on public link (activation/deactivation) of your bubbles.

Link copied to clipboard
abstract fun updateBubble(room: IRainbowRoom, body: CreateRoomBody, listener: RainbowListener<IRainbowRoom, Unit>?)

Update a bubble

Link copied to clipboard
abstract fun updateBubbleTags(tags: List<RoomTag>, room: IRainbowRoom, listener: RainbowListener<List<RoomTag>, Unit>? = null)

Add, update or delete tags for a specified Room

Link copied to clipboard
abstract fun updateCustomDataForBubble(room: IRainbowRoom, customData: JSONObject, listener: RainbowListener<IRainbowRoom, Unit>? = null)

Update the customData of a bubble.

Link copied to clipboard
abstract fun uploadRoomAvatar(room: IRainbowRoom?, photoFile: File?, listener: RainbowListener<Unit, Unit>? = null)

change Photo of Meeting